home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / zangband.lha / Zangband261 / help / readme.txt < prev    next >
Encoding:
Text File  |  2001-07-01  |  4.2 KB  |  109 lines
  1. === Notes on Zangband Documentation ===
  2.  
  3. This file sets out basic information regarding the official Zangband
  4. documentation package produced by the Zangband DevTeam. 
  5.  
  6.  
  7. --- Documentation Packages ---
  8.  
  9. There are currently two documentation packages planned. The basic
  10. package will include non-spoiler information necessary for a new player
  11. to learn all he needs to know about playing Zangband and will be
  12. included in all official Zangband source and binary releases. The
  13. extended package will included additional spoiler files and will be
  14. available for download separately. Care will be taken to ensure that
  15. the two packages merge together properly.
  16.  
  17.  
  18. --- Available Formats ---
  19.  
  20. The Zangband basic documentation package is currently available in
  21. plain text format and is included in all Zangband downloads. Both the
  22. basic documentation and the spoilers are available for browsing in
  23. HTML format on Zangband.org.
  24.  
  25.  
  26. --- Reporting Errors / Suggestions for Improvement ---
  27.  
  28. While every effort will be taken to ensure that the documentation
  29. packages are accurate and up to date, it is inevitable that some
  30. errors will be made. If you find an error or have a suggestion to
  31. improve documentation, please post your report or idea to the Zangband
  32. Development list by mailing to jianson@zangband.org. Alternatively, you
  33. may post your report or idea to rec.games.roguelike.angband.
  34.  
  35.  
  36. --- Rules for Creating Documents ---
  37.  
  38. Certain general rules have been applied in creating the official
  39. documentation for Zangband. The DevTeam welcomes contributions by
  40. players and if you wish to contribute a spoiler or other helpfile we
  41. would appreciate your adherence to the following guidelines. We reserve
  42. the right to modify your file but you will retain credit as the
  43. original author.
  44.  
  45. 1.  All documents should be named using the standard 8.3 format since
  46.     Zangband is played on systems which do not support long filenames.
  47. 2.  Menu files should be named *.hlp, non-spoiler help files *.txt and
  48.     spoiler helpfiles *.spo.
  49. 3.  All documents should be in a fixed font, plain text format.
  50. 4.  Line length should be between 70 and 75 characters.
  51. 5.  Please use US spelling unless it directly conflicts with the game
  52.     (for example the 'Spectre' race).
  53. 6.  No indenting of the first line of paragraphs.
  54. 7.  Left justification.
  55. 8.  Document titles are denoted by '=== Document Title ==='.
  56. 9.  Section headings are denoted by '=== Section Heading ==='.
  57. 10. Sub-section headings are denoted by '--- Sub-section Heading ---'.
  58. 11. Information on document authors and editors and revisions should
  59.     be included at the end of each document.
  60. 12. Indenting increments by 4 or 5 spaces each time.
  61.  
  62.  
  63. === Hyperlinks ===
  64.  
  65. Zangband supports links between help files as follows. At the point in
  66. the text where you wish to insert a link, place the text '[#]' where '#'
  67. is any letter or digit ('a' and 'A' are distinct for this purpose).
  68. This is to tell the reader which key to press to activate the link.
  69. Then, at the end of the file, place the following text (including the
  70. asterisks) where 'target_filename' is the name of the file you wish to
  71. link to:
  72.  
  73.      ***** [#] target_filename
  74.  
  75. Now, when the user presses '#', the helpfile system will open up the
  76. target file. Opening the new file will flush the previous links so
  77. '#' may be reused.
  78.  
  79. Note: because various operating systems use different conventions to
  80. denote directory structures, Zangband does not support target file
  81. names like './spoiler/races/races.spo'. This means that all help files
  82. should be kept in the lib/help or lib/info directory.
  83.  
  84. We are currently testing methods of linking to a particular section
  85. in a document and may also implement histories to allow 'back' and
  86. 'forward' actions similar to web browsers.
  87.  
  88. --- Tags ---
  89.  
  90. A "tag" is something like a bookmark, it marks a line for reference by
  91. a hyperlink.  A tag is specified with:
  92.  
  93.     ***** <tag_name>
  94.  
  95. (the name of the tag can not be longer than 15 characters).
  96.  
  97. You can then jump to the line marked with the tag with:
  98.  
  99.     ***** [1] target_filename#tag_name
  100.  
  101. This command jumps to the line with the tag "tag_name" in the file
  102. target_file.  You can jump inside the current file too (just use the
  103. filename of the current file in the link).
  104.  
  105. -- 
  106. Original    : Zangband DevTeam
  107. Last update : February 19, 2001
  108.  
  109.